/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hdds.scm.block;

import org.apache.hadoop.hdds.protocol.proto.StorageContainerDatanodeProtocolProtos.DeletedBlocksTransaction;
import org.apache.hadoop.hdds.scm.metadata.Replicate;
import org.apache.hadoop.hdds.utils.db.Table;
import org.apache.hadoop.hdds.utils.db.TableIterator;
import org.apache.hadoop.hdds.utils.db.Table.KeyValue;

import java.io.IOException;
import java.util.ArrayList;

/**
 * DeletedBlockLogStateManager interface to
 * manage deleted blocks and record them in the underlying persist store.
 */
public interface DeletedBlockLogStateManager {
  @Replicate
  void addTransactionsToDB(ArrayList<DeletedBlocksTransaction> txs)
      throws IOException;

  @Replicate
  void removeTransactionsFromDB(ArrayList<Long> txIDs)
      throws IOException;

  @Replicate
  void increaseRetryCountOfTransactionInDB(ArrayList<Long> txIDs)
      throws IOException;

  @Replicate
  int resetRetryCountOfTransactionInDB(ArrayList<Long> txIDs)
      throws IOException;

  TableIterator<Long,
      KeyValue<Long, DeletedBlocksTransaction>> getReadOnlyIterator()
      throws IOException;

  void onFlush();

  void reinitialize(Table<Long, DeletedBlocksTransaction> deletedBlocksTXTable);
}
